Add issue templates #2355
Add issue templates #2355
Conversation
penelopeysm
force-pushed
the
py/issue-template
branch
from
da5c5f5
to
9ce4037
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2355 +/- ##
==========================================
- Coverage 86.86% 86.80% -0.07%
==========================================
Files 24 24
Lines 1599 1599
==========================================
- Hits 1389 1388 -1
- Misses 210 211 +1 ☔ View full report in Codecov by Sentry. |
Pull Request Test Coverage Report for Build 11135548416Details
💛 - Coveralls |
|
Yeah, I'm kind of unsure about that too. I don't really have any problem with blank issues in and of themselves, it's just that it's less "complete" since blank issues won't get added to the project board. |
|
IIUC there's no difference between the "Anything else" and the "blank issue" right? Other than being added to the board? |
|
@torfjelde Without <details>, with <details> I do like the latter 🙂 |
|
Of course, it's never as good as one expects:
So the issue won't be added to the project board unless it's basically one of us opening the issue. But I suppose it's still a useful way to guide people submitting bugs. In view of this, I've re-enabled blank issues and removed 'anything else' as it means there's one less template to maintain. I'll also look into a separate way of auto-adding issues. |
penelopeysm
force-pushed
the
py/issue-template
branch
from
39a79d8
to
75e60d3
Compare
Description
GitHub has a nice feature for issue templates, which basically mean that people submitting an issue do it by filling in a form rather than providing freeform text.
This has a couple of benefits:
We can explicitly require people to provide an MWE as well as the info needed to reproduce their bug (i.e. manifest and version info). Not having this info is annoying.
Issues added via this form should be automatically added to our project board. (See Adding new issues and PRs to Project Board automatically. #2315)Only happens if the issue is opened by someone who already has write access to the project board.This PR adds two templates - one for bug reports and one for 'anything else', which is mostly blank. In theory we could have a feature request one too, although I don't think that a feature request template would substantially differ from 'anything else'.
It also adds a config file which disables blank issues (i.e., it forces people to use the templates).
Preview the changes
To have a peek at what this would look like, I've added the same issue template to a playground repository of mine: https://github.com/penelopeysm/Shaymin.jl/issues Feel free to create an issue there and see the output. Note: on this repository blank issues are still permitted (blue circle below). This is just to let you see what that looks like. I've disabled the option in this PR.
The rest of the organisation
If we like how this works, then I propose we add the same templates to other repos in TuringLang too, which (should) accomplish our aim of issues across the organisation being added to the project board.